[codex] Align briefprint docs and metadata#17
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates documentation across several files to align with the current implementation status, clarifies naming conventions, and documents the behavior of the --sensitive and --redact-secrets flags. It also removes the unused corrupt_hmac_failed event reason from the models and adds corresponding tests. The review feedback suggests improving test robustness by avoiding hardcoded date assertions in test_installable_skill_bundle.py and safely extracting cache keys in test_pipeline_cache.py to prevent potential StopIteration errors.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| for section in [ | ||
| "Verified surfaces", | ||
| "Community-compatible notes", | ||
| "Last checked: 2026-07-04", | ||
| "Verify installed files", | ||
| ]: | ||
| assert section in doc |
There was a problem hiding this comment.
Hardcoding the exact date "Last checked: 2026-07-04" in the test assertion makes the test fragile to future documentation updates. If the documentation is updated with a new date, this test will fail. Consider using a regular expression to validate the presence of a date pattern instead.
| for section in [ | |
| "Verified surfaces", | |
| "Community-compatible notes", | |
| "Last checked: 2026-07-04", | |
| "Verify installed files", | |
| ]: | |
| assert section in doc | |
| for section in [ | |
| "Verified surfaces", | |
| "Community-compatible notes", | |
| "Verify installed files", | |
| ]: | |
| assert section in doc | |
| assert re.search(r"Last checked: \\d{4}-\\d{2}-\\d{2}", doc) |
| doc = DocumentInput(document_id="corrupt-doc", title="Corrupt", text="Action: owner should inspect cache.") | ||
| pipeline = BriefingPipeline(cache_dir=tmp_path) | ||
| first = pipeline.run([doc], use_output_cache=False) | ||
| key = first.stats.cache_keys[next(name for name in first.stats.cache_keys if name.startswith("document:"))] |
There was a problem hiding this comment.
Using next() with a generator expression on cache_keys will raise a StopIteration if no matching key is found, which can be hard to debug. Explicitly extracting the keys and asserting that exactly one document key exists improves test robustness and error clarity.
| key = first.stats.cache_keys[next(name for name in first.stats.cache_keys if name.startswith("document:"))] | |
| doc_keys = [k for k in first.stats.cache_keys if k.startswith("document:")] | |
| assert len(doc_keys) == 1 | |
| key = first.stats.cache_keys[doc_keys[0]] |
1 participant
Summary
briefprintskill naming versusdocument-briefing-cacheruntime/package naming.corrupt_hmac_failedcache event reason and add focused regression coverage for corrupt document-cache events.Validation
python -m pytest -q -p no:cacheprovider->164 passed, 2 skippedpython scripts\validate_skill.py --run-evals->OK: briefprint skill repository validated (24 test files, 9 eval cases, 9 trigger cases, 4 model benchmark cases)ruff check .->All checks passed!git diff --check-> no whitespace errorsrg -n "Status: proposed|corrupt_hmac_failed" src references tests README.md README.ko.md docs/agent-skill-installation.md agents scripts skills-> no outputNotes
Local agent workflow artifacts (
.agent/,.superpowers/, anddocs/superpowers/plans/2026-07-04-briefprint-consistency-cleanup-plan.md) were intentionally left out of this PR because they are execution records rather than product or repository-facing changes.